.TH std::atomic_flag_test,std::atomic_flag_test_explicit 3 "2024.06.10" "http://cppreference.com" "C++ Standard Libary"
.SH NAME
std::atomic_flag_test,std::atomic_flag_test_explicit \- std::atomic_flag_test,std::atomic_flag_test_explicit

.SH Synopsis
   Defined in header <atomic>
   bool atomic_flag_test( const volatile std::atomic_flag* object )   \fB(1)\fP \fI(since C++20)\fP
   noexcept;
   bool atomic_flag_test( const std::atomic_flag* object ) noexcept;  \fB(2)\fP \fI(since C++20)\fP
   bool atomic_flag_test_explicit( const volatile std::atomic_flag*
   object,                                                            \fB(3)\fP \fI(since C++20)\fP
                                   std::memory_order order )
   noexcept;
   bool atomic_flag_test_explicit( const std::atomic_flag* object,
                                   std::memory_order order )          \fB(4)\fP \fI(since C++20)\fP
   noexcept;

   Atomically reads the value of the *object and returns the value.

   1,2) The memory synchronization order is std::memory_order_seq_cst.
   3,4) The memory synchronization order is order.
   If order is one of std::memory_order::release and std::memory_order::acq_rel, the
   behavior is undefined.

.SH Parameters

   object - pointer to the atomic_flag object to read
   order  - the memory synchronization ordering

.SH Return value

   The value atomically read.

.SH Notes

       Feature-test macro      Value    Std          Feature
   __cpp_lib_atomic_flag_test 201907L (C++20) std::atomic_flag::test

.SH Example

    This section is incomplete
    Reason: no example

.SH See also

   test    atomically returns the value of the flag
   (C++20) \fI(public member function of std::atomic_flag)\fP

.SH Category:
     * Todo no example
